Skip to content

Set up custom-instructions.md for NLWebNet repository #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Jun 20, 2025
Merged

Set up custom-instructions.md for NLWebNet repository #11

merged 4 commits into from
Jun 20, 2025

Conversation

Copy link
Contributor

Copilot AI commented Jun 20, 2025 •
edited
Loading

Created a comprehensive custom-instructions.md file to provide guidance for AI assistants working with the NLWebNet codebase. This document serves as a reference for understanding the project's architecture, patterns, and development practices.

Key Sections Added

Project Context

  • NLWeb Protocol Implementation - .NET implementation of Microsoft's NLWeb standard
  • Proof-of-Concept Status - Clear emphasis that this is experimental software for testing/evaluation only
  • Technology Stack - .NET 9, ASP.NET Core, Blazor, Microsoft.Extensions.AI, Model Context Protocol

Architecture Guidance

  • Minimal API Preference - Documents the transition from traditional Controllers to Minimal APIs
  • Dependency Injection Patterns - Service registration via AddNLWebNet() extension methods
  • Service Layer Design - Clear interfaces and implementation patterns

Development Standards

  • Code Conventions - C# style guidelines, namespace organization, XML documentation requirements
  • Testing Approach - 39 unit tests with MSTest + NSubstitute, manual testing guides
  • CI/CD Pipeline - GitHub Actions workflow, NuGet packaging, validation scripts

NLWeb Protocol Implementation

  • Core Concepts - Three query modes (List, Summarize, Generate), streaming support
  • MCP Integration - Model Context Protocol support with tools and prompts
  • Request/Response Flow - Processing pipeline through services and data backends

AI Assistant Guidance

  • Common Patterns - When adding features, modifying endpoints, or adding dependencies
  • Limitations and Constraints - Current implementation status and deployment considerations
  • When to Seek Clarification - Guidelines for complex changes or architectural decisions

This documentation will help AI assistants provide more contextually appropriate suggestions and maintain consistency with the project's experimental nature and architectural patterns.

Fixes #10.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Set up custom-instructions.md for this repo Set up custom-instructions.md for NLWebNet repository Jun 20, 2025
Copilot AI requested a review from jongalloway June 20, 2025 22:02
Copilot finished work on behalf of jongalloway June 20, 2025 22:02
@jongalloway
Copy link
Collaborator

jongalloway commented Jun 20, 2025

@copilot There is some verbiage about this not being production code and a learning project. This is intended as production code. The demo app should be simple where possible, but the NuGet package is intended for production use and should follow all best practices.

Copy link
Contributor Author

Copilot AI commented Jun 20, 2025

@copilot There is some verbiage about this not being production code and a learning project. This is intended as production code. The demo app should be simple where possible, but the NuGet package is...

Updated the custom-instructions.md to reflect that this is production-ready code. Removed all experimental/proof-of-concept language and reframed the project as a production NuGet package with a simple demo app. Commit: 8e7c3b2

Copilot finished work on behalf of jongalloway June 20, 2025 22:13
@jongalloway
Copy link
Collaborator

jongalloway commented Jun 20, 2025

@copilot One more clarification: the current state is that it's prerelease and not ready. However, the goal of this repo is to create a library that is intended for production use. So any code additions or edits should be production quality, but currently this is an early prerelease that is not production ready.

Copy link
Contributor Author

Copilot AI commented Jun 20, 2025

@copilot One more clarification: the current state is that it's prerelease and not ready. However, the goal of this repo is to create a library that is intended for production use. So any code additio...

Updated the custom-instructions.md to clarify that the library is currently in early alpha prerelease (not yet production ready) while maintaining the goal of creating a production-quality library with high code standards. Commit: 2b470c0

Copilot finished work on behalf of jongalloway June 20, 2025 22:54
@jongalloway jongalloway marked this pull request as ready for review June 20, 2025 22:57
@jongalloway jongalloway merged commit 151ee76 into main Jun 20, 2025
7 checks passed
@jongalloway jongalloway deleted the copilot/fix-10 branch July 1, 2025 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@jongalloway jongalloway jongalloway approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@jongalloway jongalloway

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Set up custom-instructions.md for this repo

2 participants

@jongalloway